<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Create auto-follow pattern API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'ccr-put-auto-follow-pattern.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-put-auto-follow-pattern.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-put-auto-follow-pattern.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/ccr-put-auto-follow-pattern.html" rel="nofollow" target="_blank">../en/ccr-put-auto-follow-pattern.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="ccr-apis.html">Cross-cluster replication APIs</a></span>
»
<span class="breadcrumb-node">Create auto-follow pattern API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="ccr-get-follow-info.html">« Get follower info API</a>
</span>
<span class="next">
<a href="ccr-delete-auto-follow-pattern.html">Delete auto-follow pattern API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="ccr-put-auto-follow-pattern"></a>Create auto-follow pattern API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Creates an auto-follow pattern.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT /_ccr/auto_follow/&lt;auto_follow_pattern_name&gt;
{
  "remote_cluster" : "&lt;remote_cluster&gt;",
  "leader_index_patterns" :
  [
    "&lt;leader_index_pattern&gt;"
  ],
  "follow_index_pattern" : "&lt;follow_index_pattern&gt;"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1442.console"></div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">read</code> and <code class="literal">monitor</code>
index privileges for the leader index patterns. You must also have <code class="literal">manage_ccr</code>
cluster privileges on the cluster that contains the follower index. For more
information, see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API creates a new named collection of
<a class="xref" href="ccr-auto-follow.html" title="Automatically following indices">auto-follow patterns</a> against the remote cluster
specified in the request body. Newly created indices on the remote cluster
matching any of the specified patterns will be automatically configured as follower
indices.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-path-parms"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;auto_follow_pattern_name&gt;</code>
</span>
</dt>
<dd>
(Required, string) The name of the collection of auto-follow patterns.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-request-body"></a>Request body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">remote_cluster</code>
</span>
</dt>
<dd>
(Required, string) The <a class="xref" href="modules-remote-clusters.html" title="Remote clusters">remote cluster</a> containing
the leader indices to match against.
</dd>
<dt>
<span class="term">
<code class="literal">leader_index_patterns</code>
</span>
</dt>
<dd>
(Optional, array) An array of simple index patterns to match against indices
in the remote cluster specified by the <code class="literal">remote_cluster</code> field.
</dd>
<dt>
<span class="term">
<code class="literal">follow_index_pattern</code>
</span>
</dt>
<dd>
(Optional, string) The name of follower index. The template <code class="literal">{{leader_index}}</code>
can be used to derive the name of the follower index from the name of the
leader index.
</dd>
</dl>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">max_read_request_operation_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations to pull per read from the remote
cluster.
</dd>
<dt>
<span class="term">
<code class="literal">max_outstanding_read_requests</code>
</span>
</dt>
<dd>
(long) The maximum number of outstanding reads requests from the remote
cluster.
</dd>
<dt>
<span class="term">
<code class="literal">max_read_request_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">max_write_request_operation_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations per bulk write request executed on
the follower.
</dd>
<dt>
<span class="term">
<code class="literal">max_write_request_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum total bytes of operations per bulk write request
executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">max_outstanding_write_requests</code>
</span>
</dt>
<dd>
(integer) The maximum number of outstanding write requests on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">max_write_buffer_count</code>
</span>
</dt>
<dd>
(integer) The maximum number of operations that can be queued for writing.
When this limit is reached, reads from the remote cluster will be deferred
until the number of queued operations goes below the limit.
</dd>
<dt>
<span class="term">
<code class="literal">max_write_buffer_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>) The maximum total bytes of operations that can be
queued for
writing. When this limit is reached, reads from the remote cluster will be
deferred until the total bytes of queued operations goes below the limit.
</dd>
<dt>
<span class="term">
<code class="literal">max_retry_delay</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>) The maximum time to wait before retrying an
operation that failed exceptionally. An exponential backoff strategy is
employed when retrying.
</dd>
<dt>
<span class="term">
<code class="literal">read_poll_timeout</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>) The maximum time to wait for new operations on the
remote cluster when the follower index is synchronized with the leader index.
When the timeout has elapsed, the poll for operations will return to the
follower so that it can update some statistics. Then the follower will
immediately attempt to read from the leader again.
</dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="_default_values_3"></a>Default values<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow-request-body.asciidoc">edit</a>
</h4>
</div></div></div>
<p>The following output from the follow info api describes all the default
values for the above described index follow request parameters:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "follower_indices" : [
    {
      "parameters" : {
        "max_read_request_operation_count" : 5120,
        "max_read_request_size" : "32mb",
        "max_outstanding_read_requests" : 12,
        "max_write_request_operation_count" : 5120,
        "max_write_request_size" : "9223372036854775807b",
        "max_outstanding_write_requests" : 9,
        "max_write_buffer_count" : 2147483647,
        "max_write_buffer_size" : "512mb",
        "max_retry_delay" : "500ms",
        "read_poll_timeout" : "1m"
      }
    }
  ]
}</pre>
</div>
</div>

</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-put-auto-follow-pattern-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This example creates an auto-follow pattern named <code class="literal">my_auto_follow_pattern</code>:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT /_ccr/auto_follow/my_auto_follow_pattern
{
  "remote_cluster" : "remote_cluster",
  "leader_index_patterns" :
  [
    "leader_index*"
  ],
  "follow_index_pattern" : "{{leader_index}}-follower",
  "max_read_request_operation_count" : 1024,
  "max_outstanding_read_requests" : 16,
  "max_read_request_size" : "1024k",
  "max_write_request_operation_count" : 32768,
  "max_write_request_size" : "16k",
  "max_outstanding_write_requests" : 8,
  "max_write_buffer_count" : 512,
  "max_write_buffer_size" : "512k",
  "max_retry_delay" : "10s",
  "read_poll_timeout" : "30s"
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1443.console"></div>
<p>The API returns the following result:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "acknowledged" : true
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="ccr-get-follow-info.html">« Get follower info API</a>
</span>
<span class="next">
<a href="ccr-delete-auto-follow-pattern.html">Delete auto-follow pattern API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>